<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>Codimension Python IDE - Documentation</title>
  <meta name="Author" content="Sergey Satskiy">
  <meta name="description" content="Codimension is a Python IDE with a focus on graphics representation of the control flow">
  <meta name="keywords" content="codimension,python,ide,flowchart,analysis,linux,open source,free software,libre software,libre,freedom,diagram,flowchart,software,download,platform,ubuntu,fedora,debian,documentation,screenshots,home,homepage">
  <link rel="apple-touch-icon" sizes="144x144" href="../assets/cdm/images/apple-touch-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="114x114" href="../assets/cdm/images/apple-touch-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="72x72" href="../assets/cdm/images/apple-touch-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="57x57" href="../assets/cdm/images/apple-touch-icon-57x57.png">
  <link rel="shortcut icon" type="image/png" href="../assets/cdm/images/cdm-logo-64x64.png">
  <link rel="stylesheet" type="text/css" href="../assets/cdm/css/main.css">
  <link rel="stylesheet" type="text/css" href="../assets/cdm/css/text.css">
  <link rel="stylesheet" type="text/css" href="../assets/cdm/css/github.css">

  <script type="text/javascript" src="../assets/cdm/js/jquery.min.js"></script>
  <script type="text/javascript" src="../assets/cdm/js/highlight.pack.js"></script>
  <script>
  hljs.initHighlightingOnLoad();
  </script>
</head>
<body id="page-" class="">
  <div class="header">
    <div id="cleartop">
      <div id="logo">
        <a href="../index.htm"><img src="../assets/cdm/images/cdm-label.svg" height="64" alt="Codimension"></a>
      </div>
      <div id="header-right">
        <ul id="topdrops">
          <h2 style="border-bottom: 1px solid #ddd; font-size: 140%; font-weight: normal; margin: 1.5ex 0 0.5ex;">English</h2>
        </ul>
        <!--
          <form id="topsearch" action="search-results.html" method="get">
          <input type="text" name="search" id="q" placeholder="Search">
          <button type="submit"><img src="/assets/cdm/images/search.svg" alt="Search"/></button>
          </form>
        -->
      </div>
    </div>
    <div class="nav">
      <ul id="menu">
        <li class="child">
          <a href="../index.htm">Home</a>
        </li>
        <li class="child">
          <a href="../about/index.htm">About</a>
          <ul>
            <li class="child">
              <a href="../about/features.html">Features</a>
            </li>
            <li class="child">
              <a href="../about/screenshots.html">Screenshots</a>
            </li>
            <li class="child">
              <a href="../about/team.html">Team</a>
            </li>
          </ul>
        </li>
        <li class="child">
          <a href="../download/index.htm">Download</a>
          <ul>
            <li class="child">
              <a href="../download/linuxdownload.html">Linux and Mac Download and Installation</a>
            </li>
            <li class="child">
              <a href="../download/sourcedownload.html">Download Source Code</a>
            </li>
            <li class="child">
              <a href="../download/runfromgit.html">Building and Running from Source</a>
            </li>
          </ul>
        </li>
        <li class="child ancestor">
          <a href="index.htm">Documentation</a>
          <ul>
            <li class="child">
              <a href="visualization-technology/index.htm">Visualization Technology</a>
            </li>
            <li class="child">
              <a href="faq.html">FAQ</a>
            </li>
            <li class="child">
              <a href="cheatsheet.html">Key Bindings & Cheatsheet</a>
            </li>
            <li class="child">
              <a href="pluginstutorial.html">Plugins Tutorial</a>
            </li>
            <li class="child">
              <a href="cdmpyparser.html">Brief Python Parser</a>
            </li>
            <li class="child">
              <a href="cdmflowparser.html">Control Flow Parser</a>
            </li>
            <li class="child">
              <a href="codimension-ide-architecture.html">Architecture</a>
            </li>
          </ul>
        </li>
        <li class="child">
          <a href="../contribute/index.htm">Contribute</a>
          <ul>
            <li class="child">
              <a href="../contribute/codingcontribute.html">Via Working with Code</a>
            </li>
            <li class="child">
              <a href="../contribute/noncodingcontribute.html">Non-Coding</a>
            </li>
          </ul>
        </li>
        <li class="child">
          <a href="../supportus.html">Support Us</a>
        </li>
      </ul>
    </div>
  </div>
  <div id="content">
    <div class="wrapper">
      <div class="breadcrumbs">
        <a href="../index.htm">Home</a>&nbsp;&nbsp;»&nbsp;&nbsp;Documentation
      </div>
      <h1>Documentation</h1>
      <p>The Codimension documentation includes the following:</p>
      <ul>
        <li>The <a href="visualization-technology/index.htm">"Python Code Visualization. Text to Flowcharts"</a> article covers the technology behind the tool and tells the story from the idea till
        the IDE implementation and beyond. You will find there a motivation for the tool, detailed description of the graphics primitives, implementation details, CML language description and
        thoughts on the future of the IDE.
        </li>
        <li>
          <a href="faq.html">Frequently asked questions</a> which are rather non-technical and can give a good understanding what codimension is and why it is designed the way it is.
        </li>
        <li>
          <a href="cheatsheet.html">Key bindings</a> section has a comprehensive description of the keyboard hot keys and some more. There is as well a cheatsheet for downloading which can be printed
          and be handy while getting used to the IDE.
        </li>
        <li>
          <a href="pluginstutorial.html">Plugins tutorial</a> tells about how the plugin subsystem is designed and how to develop the IDE plugins in Python. It also has a complete example of a simple
          garbage collecting plugin.
        </li>
        <li>The <a href="cdmpyparser.html">brief python parser</a> section describes the first of the modules developed within the project. This parser extracts the information about functions,
        classes, imports, docstrings etc. found in a Python code.
        </li>
        <li>The <a href="cdmflowparser.html">control flow parser</a> section describes the second of the modules developed within the project. This parser extracts the information about where each
        fragment of the code is located and how they are related to each other. That information is a source for generating flowchart diagrams.
        </li>
        <li>The <a href="codimension-ide-architecture.html">IDE architecture</a> article describes what components are in the IDE and their purpose.
        </li>
      </ul>
    </div>
  </div>
  <div class="footer">
    <table width="100%">
      <tr>
        <td>
          Codimension is Free and Open Source Software licensed under the <a href="http://www.gnu.org/licenses/gpl-3.0.html">GPL v3.0</a>
        </td>
        <td align="right">
          <a href="../sitemap.html">Sitemap</a>
        </td>
      </tr>
    </table>
  </div>
</body>
</html>
